UserRolesData

The user-role object contains a list of all roles to add or remove for the specified user.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

userId

The system ID of the user

Y

string

rolesToAdd

The a list of role ID's to ADD to the user

-

array

rolesToRemove

The a list of role ID's to REMOVE from the user

-

array

*Required elements are only used for API parameters

Usages
  • /API/admin/updateUserRoles
  • /API2/access/updateUserRoles